Cron format and examples
Cron expressions can be used to schedule a Compose task. This appendix describes the Cron format used in Compose (Quartz), provides a description of the special characters that can be used in an expression and ends with some examples of Cron usage.
Cron format
A cron expression is a string comprised of five fields separated by a white space. Fields can contain any of the allowed values, along with various combinations of the allowed special characters for that field. The fields are described in the table below.
Field Name | Mandatory | Allowed Values | Allowed Special Characters |
---|---|---|---|
Seconds |
0-59 |
, - * / |
|
Minutes |
0-59 |
, - * / |
|
Hours |
0-23 |
, - * / |
|
Day of month |
1-31 |
, - * ? / L W |
|
Month |
1-12 or JAN-DEC |
, - * / |
|
Days of week |
1-7 or SUN-SAT |
, - * ? / L # |
Special characters
The following special characters are supported:
- * ("all values") Used to select all values within a field. For example, "*" in the minute field means "every minute".
- ? ("no specific value") Useful when you need to specify something in one of the two fields in which the character is allowed, but not the other. For example, if I want my task to run on a particular day of the month (say, the 10th), but don't care what day of the week that happens to be, I would put "10" in the day-of-month field, and "?" in the day-of-week field. See the examples below for clarification.
- - Used to specify ranges. For example, "10-12" in the hour field means "the hours 10, 11 and 12".
- , Used to specify additional values. For example, "MON,WED,FRI" in the day-of-week field means "the days Monday, Wednesday, and Friday".
- / Used to specify increments. For example, "0/15" in the seconds field means "the seconds 0, 15, 30, and 45". And "5/15" in the seconds field means "the seconds 5, 20, 35, and 50". You can also specify '/' after the '' character - in this case '' is equivalent to having '0' before the '/'. '1/3' in the day-of-month field means "run every 3 days starting on the first day of the month".
- L ("last") Has a different meaning in each of the two fields in which it is allowed. For example, the value "L" in the day-of-month field means "the last day of the month" - day 31 for January, day 28 for February on non-leap years. If used in the day-of-week field by itself, it simply means "7" or "SAT". But if used in the day-of-week field after another value, it means "the last xxx day of the month" - for example "6L" means "the last friday of the month". You can also specify an offset from the last day of the month, such as "L-3" which would mean the third-to-last day of the calendar month. When using the 'L' option, it is important not to specify lists, or ranges of values, as you'll get confusing/unexpected results.
- W ("weekday") Used to specify the weekday (Monday-Friday) nearest the given day. As an example, if you were to specify "15W" as the value for the day-of-month field, the meaning is: "the nearest weekday to the 15th of the month". So if the 15th is a Saturday, the trigger will run on Friday the 14th. If the 15th is a Sunday, the trigger will run on Monday the 16th. If the 15th is a Tuesday, then it will run on Tuesday the 15th. However if you specify "1W" as the value for day-of-month, and the 1st is a Saturday, the trigger will run on Monday the 3rd, as it will not 'jump' over the boundary of a month's days. The 'W' character can only be specified when the day-of-month is a single day, not a range or list of days. ** The 'L' and 'W' characters can also be combined in the day-of-month field to yield 'LW', which translates to "last weekday of the month".
- # Used to specify "the nth" XXX day of the month. For example, the value of "6#3" in the day-of-week field means "the third Friday of the month" (day 6 = Friday and "#3" = the 3rd one in the month). Other examples: "2#1" = the first Monday of the month and "4#5" = the fifth Wednesday of the month. Note that if you specify "#5" and there is not 5 of the given day-of-week in the month, then no firing will occur that month. ** The legal characters and the names of months and days of the week are not case sensitive. MON is the same as mon.
Usage examples
Here are some examples of cron expressions and their effect.
Cron expression example | Trigger frequency |
---|---|
0 0 12 * * ? | 12 pm (noon) every day |
0 15 10 ? * * | 10:15am every day |
0 15 10 * * ? | 10:15am every day |
0 15 10 * * ? * | 10:15am every day |
0 15 10 * * ? 2005 | 10:15am every day during the year 2005 |
0 * 14 * * ? | Every minute starting at 2pm and ending at 2:59pm every day |
0 0/5 14 * * ? | Every 5 minutes starting at 2pm and ending at 2:55pm every day |
0 0/5 14,18 * * ? | Every 5 minutes starting at 2pm and ending at 2:55pm every day, AND every 5 minutes starting at 6pm and ending at 6:55pm every day |
0 0-5 14 * * ? | Every minute starting at 2pm and ending at 2:05pm every day |
0 10,44 14 ? 3 WED | At 2:10pm and at 2:44pm every Wednesday, in the month of March |
0 15 10 ? * MON-FRI | At 10:15am every day from Monday - Friday |
0 15 10 15 * ? | 10:15am on the 15th day of every month |
0 15 10 L * ? | 10:15am on the last day of every month |
0 15 10 ? * 6L | 10:15am on the last Friday of every month |
0 15 10 ? * 6L 2002-2005 | 10:15am on the last Friday of every month, during the years 2002-2005 |
0 15 10 ? * 6#3 | 10:15am on the third Friday of every month |
0 0 12 1/5 * ? | 12pm (noon) every 5 days every month, starting on the first day of the month |
0 11 11 11 11 ? | 11:11am on every November 11th |